/*
 * Copyright (c) 2025, 2025, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.svm.core.util;

import java.util.AbstractList;
import java.util.ArrayList;
import java.util.List;

import com.oracle.svm.core.heap.RestrictHeapAccess;
import com.oracle.svm.core.util.ImageHeapList.HostedImageHeapList;

/**
 * Super type for {@link HostedImageHeapList} and {@link RuntimeImageHeapList} that allows declaring
 * a more restricted type for fields initialized with {@link ImageHeapList#create(Class)} to aid
 * open-world analysis. When such a field is analysed in an open-world it gets injected all possible
 * subtypes of its declared type. Declaring the type as {@link AbstractImageHeapList} allows us to
 * only inject {@link RuntimeImageHeapList}.This enables a more precise analysis and avoids for
 * example triggering false-positive violations of @{@link RestrictHeapAccess}: if the field was
 * declared as {@link List} then implementations of {@link List} for which simple access operations
 * can allocate, such as {@link ArrayList#get(int)}, could become reachable from code annotated
 * with @{@link RestrictHeapAccess}.
 */
public abstract sealed class AbstractImageHeapList<E> extends AbstractList<E> permits HostedImageHeapList, RuntimeImageHeapList {
}
